home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / opus / lgit101b.zip / LOGIT.DOC next >
Text File  |  1993-02-20  |  6KB  |  168 lines
  1. LOGIT version 1.01ß <wide beta>                         February 19, 1993
  2.  
  3. Program and Documentation by Michael Malone, FlaccidDisc Software
  4.  
  5. With this package you should have received:
  6.  
  7.         LOGIT.EXE   The executable
  8.         LOGIT.DOC   This fine example of documentation
  9.  
  10. Have you ever asked yourself:
  11.  
  12. "I wonder how many users read this echo?"
  13.  
  14. "Is it worth the 2 megabytes of disk space I give up for it?"
  15.  
  16. If you have, then read on.  LOGIT might just be of help.
  17.  
  18. - What LOGIT is:
  19.  
  20. LOGIT is a program that keeps track of the number of times a message area
  21. is accessed.  It does this by reading not only the Opus log but also the
  22. logs of a couple of the more popular off line mail readers. Xpress, and
  23. Blue Wave.  With this information, you as a SysOp are able to tailor the
  24. Echo Mail message areas you carry to that of the interest of your users.
  25.  
  26. - How LOGIT works:
  27.  
  28. LOGIT quickly scans the log you specify looking for the information it
  29. needs.  It then adds this information to it's own history file thus
  30. keeping a running tally.  When all the information has been gathered,
  31. LOGIT sorts the data, displays it to the screen, and writes a report file
  32. for later viewing.  It then writes it's own history file, and finally
  33. reports it's success as an entry in the log file.  This entry is used as a
  34. marker to prevent duplicate reporting.
  35.  
  36. - Making LOGIT work:
  37.  
  38. Place the file LOGIT.EXE in a convenient directory.  I would advise using
  39. the same directory as where you keep your log files.  LOGIT will create
  40. the files it needs in this directory, for this reason it is important that
  41. future runs of LOGIT be made from this directory as well.  Start LOGIT
  42. using the options below.
  43.  
  44. The command line options for LOGIT are:
  45.  
  46. LOGIT -l[x:\path\log name] -s[AreaNumber/TimesRead] -t[log type] -b[atch]
  47.  
  48. Command Line Options:
  49.  
  50. -l      This option allows you to specify the path and filename of the log
  51.         to be processed.
  52.  
  53. -s      Selects the key to sort on.  This can be set to one of two values
  54.         either AreaNumber or TimesRead.  You may abbreviate this using the
  55.         notation -sAN for AreaNumber or -sTR for TimesRead.
  56.  
  57. -t      Sets the type of log to read.  Currently this value can be set to
  58.         one of three types.  They are Opus, Xpress and Bwave.  You may
  59.         abbreviate these using the notation -tO for Opus, -tX for Xpress
  60.         and -tB for Blue Wave.
  61.  
  62. -b      This is a switch option requiring no additional values after it.
  63.         It is used to suppress the screen output of the report.  If you are
  64.         planning on running LOGIT as an UNATTENDED event it is important to
  65.         use this switch.  The report pauses after a full screen of data
  66.         and this switch suppresses the report altogether.
  67.  
  68. -?      Brief listing of the commands.
  69.  
  70. Examples:
  71.  
  72. LOGIT -lc:\opus\OPUS.LOG -tOpus -sTimesRead
  73.  
  74. Run LOGIT using the Opus log file, that is located in the C:\OPUS
  75. directory.  It is an Opus log file, and we want the data sorted by the
  76. number of times the area has been accessed.
  77.  
  78. LOGIT -lc:\opus\log\BBS.LOG -tOpus -sAreaNumber
  79.  
  80. Run LOGIT using the BBS log file, that is located in the C:\OPUS\LOG
  81. directory.  It is an Opus log file, and we want the data sorted by the
  82. Area Number.
  83.  
  84. LOGIT -lc:\opus\xpress\XPRESS.LOG -tXpress -sAreaNumber -b
  85.  
  86. Run LOGIT using the XPRESS log file, that is located in the C:\OPUS\XPRESS
  87. directory.  It is a Xpress log file, and we want the data sorted by the
  88. Area Number.  We will be running in batch mode.
  89.  
  90. - Special Cases:
  91.  
  92. Blue Wave -  Blue Wave does not record all the information we require in
  93.              it's log file.  For this reason, we must build an index file
  94.              for reference.
  95.  
  96. Sorting   -  There seems to be a small problem with sorting when the 1st
  97.              character of the area name contains a number and you sort
  98.              based on AreaNumber.  I am aware of this problem and am
  99.              trying to fix it.
  100.  
  101. - The Future:
  102.  
  103. Planned Enhancements Include:
  104.  
  105.         Date ranging and averaging.
  106.         Automated AreaFix removal of slow areas.
  107.         Support for additional log types.
  108.  
  109. - Helping Me Out:
  110.  
  111. If you have a log file that you would like included, please send me a
  112. sample and I will try and include it in the next release.
  113.  
  114. LOGIT is Cheapo-Postal-Ware.  What! you ask?  Good question.
  115.  
  116. Cheapo-Postal-Ware works like this.  I like to get letter and postcards
  117. from the users of my products.  I also collect stamps.
  118.  
  119. Please take the time to send me a letter or postcard telling me how you
  120. like the program, or just to say Hi! for that matter.  While you are
  121. putting a stamp on the outside of the letter throw a couple of extra
  122. stamps on the inside for me. Pretty easy huh?  Cheapo-Postal-Ware!
  123. With Post Cards, you can be creative!  Make a pocket on it to insert
  124. and extra stamp, or you can tape one on backwards! Be creative.
  125.  
  126. You may send comments, questions, letters and cards to:
  127.  
  128.         Michael Malone
  129.         6040 N. 7th Street #104
  130.         Phoenix, Arizona 85014
  131.  
  132. You may contact also at:
  133.  
  134.         (602) 264-2328 - 1:114/7@fidonet.org   - HST
  135.         (602) 274-2821 - 1:114/777@fidonet.org - V32
  136.         (602) 230-8094 - FAX
  137.         (602) 681-2888 - Voice
  138.  
  139.  
  140. - Legal Stuff:
  141.  
  142. DISTRIBUTION:
  143.  
  144. Send this program to who you like.  Give this file to whomever you want.
  145. You are not authorized to sell this program without prior written consent.
  146.  
  147. LICENSE:
  148.  
  149. No user may modify this software in any way, including but not limited
  150. to de compiling, disassembling or otherwise reverse engineering the program.
  151.  
  152. WARRANTY:
  153.  
  154.    The author makes no warranty of any kind express or implied, including
  155.    without limitation, any warranties of merchantability and/or fitness
  156.    for a particular purpose.
  157.  
  158. IN NO EVENT WILL FLACCIDDISC SOFTWARE INC OR THE AUTHOR BE LIABLE FOR ANY
  159. DAMAGES, WHETHER DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL INCLUDING ANY
  160. LOST PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES
  161. ARISING OUT OF YOUR USE OR INABILITY TO USE THIS PROGRAM, OR FOR ANY CLAIM
  162. BY ANY OTHER PARTY.  THIS PROGRAM IS OPERATED ENTIRELY AT THE USER'S RISK.
  163.  
  164.  
  165. This program and documentation is the sole property of FlaccidDisk
  166. Software and Michael Malone. Copyright 1993
  167.  
  168.